home *** CD-ROM | disk | FTP | other *** search
/ Deutsche Edition 1 / Deutsche Edition 1.iso / amok / 081-090 / amok90 / autodoc2.7 / autodoc.doc < prev    next >
Text File  |  1993-11-04  |  2KB  |  59 lines
  1. autodoc                                                               autodoc
  2.  
  3.    NAME
  4.        autodoc - Extracts and sorts autodocs from the given files to
  5.                  stdout.
  6.  
  7.    SYNOPSIS
  8.        autodoc [ -i ] [ -a ] [ -s ] [ -m ] [ -C ] [-d]
  9.                [ -w ] [ -tnum ] [ -lnum ] [ -c ] [ -f ] [ -I ] {files}
  10.  
  11.    DESCRIPTION
  12.        autodoc extracts autodocs from files {files}
  13.        Sorts the output to stdout.
  14.  
  15.        Options offered by autodoc are the following:
  16.  
  17.        -i      Extract ONLY internal autodocs (autodocs that have an 'i'
  18.                as the 6th character in a line that begins an autodoc).
  19.        -a      Process autodocs that begin with asterisk in the first
  20.                column.
  21.        -s      Process autodocs that begin with semicolon in the first
  22.                column.
  23.        -m      Process autodocs in Modula-2 language form.
  24.        -C      Process autodocs in C language form.
  25.  
  26.        -tnum   Convert tabs into num spaces. (not yet implamented)
  27.        -lnum   Set the line length to num. (default = 78 chars, max. 256).
  28.        -w      Turn off word wrap. Chop lines longer than line length.
  29.  
  30.        -d      include definition module as entry --interface--
  31.        -c      Convert C comments. From backslash asterisk to slash
  32.                asterisk. This allows comments in autodocs without nesting
  33.                comments. (not yet implemented)
  34.  
  35.        -f      Disable form feeds between autodoc entries.
  36.        -I      Include a TABLE OF CONTENTS as the first part of the output.
  37.  
  38.    USAGE
  39.        autodoc sends formatted file to standard output. User could redirect
  40.        this output to a file.
  41.  
  42.                autodoc > outfile file
  43.  
  44.        With the -d option there will automaticly be generated an entry
  45.        --interface-- if the filename ends with '.mod' and there exists a
  46.        corresponting '.def'-file. The contents of this file will be included
  47.        in this entry (without wordwrap).
  48.  
  49.        Ex. to extract ALL possible autodocs except internal autodocs,
  50.        generate entry --interfaec-- and print with a table of contents.
  51.  
  52.                autodoc > outfile -a -s -m -d -C -I file1
  53.  
  54.        This filter must be used only with text files.
  55.  
  56.    AUTHOR
  57.        hartmut Goebel
  58.  
  59.